home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / video / vlsetuppaths.z / vlsetuppaths
Encoding:
Text File  |  1998-10-20  |  5.2 KB  |  133 lines
  1.  
  2.  
  3.  
  4. VVVVLLLLSSSSEEEETTTTUUUUPPPPPPPPAAAATTTTHHHHSSSS((((3333ddddmmmm))))                                            VVVVLLLLSSSSEEEETTTTUUUUPPPPPPPPAAAATTTTHHHHSSSS((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      vlSetupPaths - setup VL paths
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////vvvvllll....hhhh>>>>
  13.  
  14.      iiiinnnntttt vvvvllllSSSSeeeettttuuuuppppPPPPaaaatttthhhhssss((((VVVVLLLLSSSSeeeerrrrvvvveeeerrrr ssssvvvvrrrr,,,, VVVVLLLLPPPPaaaatttthhhhLLLLiiiisssstttt ppppaaaatttthhhhssss,,,, uuuuiiiinnnntttt ccccoooouuuunnnntttt,,,,
  15.                VVVVLLLLUUUUssssaaaaggggeeeeTTTTyyyyppppeeee ccccttttrrrrllllUUUUssssaaaaggggeeee,,,, VVVVLLLLUUUUssssaaaaggggeeeeTTTTyyyyppppeeee ssssttttrrrreeeeaaaammmmUUUUssssaaaaggggeeee))));;;;
  16.  
  17. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  18.      _s_v_r           Specifies the server.
  19.  
  20.      _p_a_t_h_s         Specifies paths.
  21.  
  22.      _c_o_u_n_t         Specifies number of paths.
  23.  
  24.      _c_t_r_l_U_s_a_g_e     Specifies usage of controls.
  25.  
  26.      _s_t_r_e_a_m_U_s_a_g_e   Specifies usage of streams.
  27.  
  28. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  29.      vvvvllllSSSSeeeettttuuuuppppPPPPaaaatttthhhhssss is the function that sets up the hardware to enable
  30.      exclusive or shared usage, and prepares the hardware for the intended use
  31.      by establishing connections and switches within the device.
  32.  
  33.      Paths must be from a single device and single server.  If paths from
  34.      multiple devices are specified, the function returns -1, and vvvvllllEEEErrrrrrrrnnnnoooo is
  35.      set to the reason.
  36.  
  37.      This means that any inter-device or inter-server video data transfer must
  38.      be done by the application.
  39.  
  40.      Transfer requiring CPU intervention are not started until the
  41.      vvvvllllBBBBeeeeggggiiiinnnnTTTTrrrraaaannnnssssffffeeeerrrr function is called.
  42.  
  43.      Call vvvvllllSSSSeeeettttuuuuppppPPPPaaaatttthhhhssss again to change the usage on a set of paths.  If the
  44.      requested change in usage fails, the old usage, if any, is retained.  For
  45.      example, if exclusive use was requested, but unavailable, the old usage
  46.      would be retained.
  47.  
  48.           typedef VLPath VLPathList[];
  49.  
  50.           typedef enum VLTypeUsage
  51.               { VL_DONE_USING, VL_READ_ONLY, VL_SHARE, VL_LOCK } VLUsageType;
  52.  
  53.      Streamusage may be set to the following values:
  54.  
  55.           VL_DONE_USING
  56.                the application is finished using this path, and the hardware
  57.                resources may be released. The path is not destroyed, but it
  58.                cannot be used for transfers until it's usage is changed to
  59.                either VL_SHARE or VL_LOCK.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVLLLLSSSSEEEETTTTUUUUPPPPPPPPAAAATTTTHHHHSSSS((((3333ddddmmmm))))                                            VVVVLLLLSSSSEEEETTTTUUUUPPPPPPPPAAAATTTTHHHHSSSS((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.           VL_READ_ONLY
  75.                the application will be using the path, but will not be doing
  76.                data transfers.
  77.  
  78.           VL_SHARE
  79.                the path will be used for transfers, but can be preempted by
  80.                other paths. When using VL_SHARE, the application should pay
  81.                attention to VLStreamPreempted events.
  82.  
  83.           VL_LOCK
  84.                the path will be used for transfers and cannot be preempted.
  85.                When this path is setup, it may preempt other paths.
  86.  
  87.      Controlusage may be set to the following values:
  88.  
  89.           VL_DONE_USING
  90.                the application is finished using this path, and the hardware
  91.                resources may be released.
  92.  
  93.           VL_READ_ONLY
  94.                controls can be read, but not set. No data transfers can occur.
  95.  
  96.           VL_SHARE
  97.                controls can be read and set, and VLControlChanged events
  98.                should be watched to reflect the activities of other paths.
  99.  
  100.           VL_LOCK
  101.                prevents other paths from setting controls which reflect shared
  102.                hardware resources.
  103.  
  104. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  105.      If successful, this function returns zero.  A value of -1 indicates an
  106.      error.
  107.  
  108. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  109.      vlCreatePath(3dm), vlAddNode(3dm), vlRemoveNode(3dm),
  110.      vlBeginTransfer(3dm), vlEndTransfer(3dm)
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.